﻿//
// 懒人Excel工具箱 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

namespace MudTools.OfficeInterop.Excel;

/// <summary>
/// Excel ChartObject 对象的二次封装接口
/// 提供对 Microsoft.Office.Interop.Excel.ChartObject 的安全访问和操作
/// </summary>
public interface IExcelChartObject : ICommonWorksheet, IDisposable
{
    #region 基础属性
    /// <summary>
    /// 获取或设置图表对象是否可见
    /// 对应 ChartObject.Visible 属性
    /// </summary>
    bool Visible { get; set; }

    /// <summary>
    /// 获取图表对象的底层形状对象
    /// 对应 ChartObject.Shape 属性
    /// </summary>
    IExcelShapeRange ShapeRange { get; }

    #endregion

    #region 位置和大小

    /// <summary>
    /// 获取或设置图表对象的左边距
    /// 对应 ChartObject.Left 属性
    /// </summary>
    double Left { get; set; }

    /// <summary>
    /// 获取或设置图表对象的顶边距
    /// 对应 ChartObject.Top 属性
    /// </summary>
    double Top { get; set; }

    /// <summary>
    /// 获取或设置图表对象的宽度
    /// 对应 ChartObject.Width 属性
    /// </summary>
    double Width { get; set; }

    /// <summary>
    /// 获取或设置图表对象的高度
    /// 对应 ChartObject.Height 属性
    /// </summary>
    double Height { get; set; }

    /// <summary>
    /// 获取或设置图表对象的旋转角度
    /// 对应 ChartObject.Shape.Rotation 属性
    /// </summary>
    double Rotation { get; set; }

    #endregion

    #region 图表属性

    /// <summary>
    /// 获取图表对象的图表
    /// 对应 ChartObject.Chart 属性
    /// </summary>
    IExcelChart Chart { get; }

    /// <summary>
    /// 获取或设置图表对象是否启用宏
    /// </summary>
    bool EnableMacro { get; set; }

    /// <summary>
    /// 获取图表对象是否为嵌入式图表
    /// </summary>
    bool IsEmbedded { get; }

    /// <summary>
    /// 获取图表对象的图表类型
    /// </summary>
    int ChartType { get; }

    #endregion

    #region 操作方法
    /// <summary>
    /// 剪切图表对象
    /// 对应 ChartObject.Cut 方法
    /// </summary>
    void Cut();

    /// <summary>
    /// 调整图表对象大小
    /// </summary>
    /// <param name="width">新宽度</param>
    /// <param name="height">新高度</param>
    /// <param name="keepAspectRatio">是否保持纵横比</param>
    void Resize(double width, double height, bool keepAspectRatio = false);

    /// <summary>
    /// 移动图表对象
    /// </summary>
    /// <param name="left">新左边距</param>
    /// <param name="top">新顶边距</param>
    void Move(double left, double top);

    /// <summary>
    /// 旋转图表对象
    /// </summary>
    /// <param name="angle">旋转角度</param>
    void Rotate(double angle);

    /// <summary>
    /// 将图表对象置于最前面
    /// </summary>
    void BringToFront();

    /// <summary>
    /// 将图表对象置于最后面
    /// </summary>
    void SendToBack();

    #endregion

    #region 图表操作

    /// <summary>
    /// 设置图表数据源
    /// </summary>
    /// <param name="sourceData">数据源区域</param>
    /// <param name="plotBy">绘制方式</param>
    void SetSourceData(IExcelRange sourceData, int plotBy = 1);

    /// <summary>
    /// 设置图表类型
    /// </summary>
    /// <param name="chartType">图表类型</param>
    void SetChartType(int chartType);

    /// <summary>
    /// 应用图表布局
    /// </summary>
    /// <param name="layout">布局编号</param>
    void ApplyLayout(int layout);

    /// <summary>
    /// 重新绘制图表
    /// </summary>
    void Refresh();

    #endregion

    #region 格式设置

    /// <summary>
    /// 设置图表标题
    /// </summary>
    /// <param name="title">标题文本</param>
    void SetTitle(string title);

    /// <summary>
    /// 设置坐标轴标题
    /// </summary>
    /// <param name="axisType">坐标轴类型</param>
    /// <param name="title">标题文本</param>
    void SetAxisTitle(int axisType, string title);

    /// <summary>
    /// 设置图例位置
    /// </summary>
    /// <param name="position">图例位置</param>
    void SetLegendPosition(int position);

    /// <summary>
    /// 设置数据标签
    /// </summary>
    /// <param name="show">是否显示</param>
    void SetDataLabels(bool show);

    /// <summary>
    /// 设置网格线
    /// </summary>
    /// <param name="major">是否显示主要网格线</param>
    /// <param name="minor">是否显示次要网格线</param>
    void SetGridlines(bool major, bool minor = false);

    #endregion

    #region 导出和转换   

    /// <summary>
    /// 复制图表到新工作表
    /// </summary>
    /// <param name="worksheetName">新工作表名称</param>
    /// <returns>新创建的工作表对象</returns>
    IExcelWorksheet CopyToNewWorksheet(string worksheetName = "");
    #endregion
}
